<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: Platform specific helper APIs in Xilsecure client</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xsecure__helper__client__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Platform specific helper APIs in Xilsecure client</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1eb29d664fde12ed80f9c89c37345a5d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__helper__client__apis.html#ga1eb29d664fde12ed80f9c89c37345a5d">XSecure_UpdateHnicCryptoStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a> CryptoStatusOp, u32 CryptoMask)</td></tr>
<tr class="memdesc:ga1eb29d664fde12ed80f9c89c37345a5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to set crypto status bit of HNIC.  <a href="#ga1eb29d664fde12ed80f9c89c37345a5d">More...</a><br/></td></tr>
<tr class="separator:ga1eb29d664fde12ed80f9c89c37345a5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1c3a0850bbe7d480db69b6c18d57d01"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__helper__client__apis.html#gae1c3a0850bbe7d480db69b6c18d57d01">XSecure_UpdateCpm5NCryptoStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a> CryptoStatusOp, u32 CryptoMask)</td></tr>
<tr class="memdesc:gae1c3a0850bbe7d480db69b6c18d57d01"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to set crypto status bit of of CPM 5N.  <a href="#gae1c3a0850bbe7d480db69b6c18d57d01">More...</a><br/></td></tr>
<tr class="separator:gae1c3a0850bbe7d480db69b6c18d57d01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7393da6128bf378cf635d7f851e18ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__helper__client__apis.html#gaf7393da6128bf378cf635d7f851e18ef">XSecure_UpdatePcideCryptoStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a> CryptoStatusOp, u32 CryptoMask)</td></tr>
<tr class="memdesc:gaf7393da6128bf378cf635d7f851e18ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to set crypto status bit of PCIDE.  <a href="#gaf7393da6128bf378cf635d7f851e18ef">More...</a><br/></td></tr>
<tr class="separator:gaf7393da6128bf378cf635d7f851e18ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae60f390422826e0edcd5c4aada5a8953"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__helper__client__apis.html#gae60f390422826e0edcd5c4aada5a8953">XSecure_UpdatePkiCryptoStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a> CryptoStatusOp, u32 CryptoMask)</td></tr>
<tr class="memdesc:gae60f390422826e0edcd5c4aada5a8953"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to set crypto status bit of PKI.  <a href="#gae60f390422826e0edcd5c4aada5a8953">More...</a><br/></td></tr>
<tr class="separator:gae60f390422826e0edcd5c4aada5a8953"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga34fb190dff4e61e8f39544f732a94edf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__helper__client__apis.html#ga34fb190dff4e61e8f39544f732a94edf">XSecure_KeyUnwrap</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="struct_x_secure___key_wrap_data.html">XSecure_KeyWrapData</a> *KeyWrapData)</td></tr>
<tr class="memdesc:ga34fb190dff4e61e8f39544f732a94edf"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to unwrap the wrapped AES key.  <a href="#ga34fb190dff4e61e8f39544f732a94edf">More...</a><br/></td></tr>
<tr class="separator:ga34fb190dff4e61e8f39544f732a94edf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ab0a956262afa96bfebba076415aa8b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__helper__client__apis.html#ga9ab0a956262afa96bfebba076415aa8b">XSecure_ReleaseRsaKey</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga9ab0a956262afa96bfebba076415aa8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function releases the RSA key that is in use.  <a href="#ga9ab0a956262afa96bfebba076415aa8b">More...</a><br/></td></tr>
<tr class="separator:ga9ab0a956262afa96bfebba076415aa8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga34fb190dff4e61e8f39544f732a94edf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_KeyUnwrap </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_secure___key_wrap_data.html">XSecure_KeyWrapData</a> *&#160;</td>
          <td class="paramname"><em>KeyWrapData</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to unwrap the wrapped AES key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">KeyWrapData</td><td>Pointer to the <a class="el" href="struct_x_secure___key_wrap_data.html" title="Input and output parameters for Key wrap. ">XSecure_KeyWrapData</a> instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_INVALID_PARAM If any input parameter is invalid.</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_KeyUnwrapIpi API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca9fb8faab069c0b14121970bc6c5b2424">XSECURE_API_KEY_UNWRAP</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9ab0a956262afa96bfebba076415aa8b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_ReleaseRsaKey </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function releases the RSA key that is in use. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_INVALID_PARAM If any input parameter is invalid.</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_RsaDestroyKeyInUse API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca1f9dbb2720c7e9bcf7e1a7ca6129ac8f">XSECURE_API_RSA_RELEASE_KEY</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="gae1c3a0850bbe7d480db69b6c18d57d01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdateCpm5NCryptoStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a>&#160;</td>
          <td class="paramname"><em>CryptoStatusOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CryptoMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to set crypto status bit of of CPM 5N. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">CryptoStatusOp</td><td>Operation to set or clear crypto status bit </td></tr>
    <tr><td class="paramname">CryptoMask</td><td>Mask to set or clear crypto status bit</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca6b7c229a9a6d706cdfa97a6028cf4d4c">XSECURE_API_UPDATE_CPM5N_CRYPTO_STATUS</a>.</p>

</div>
</div>
<a class="anchor" id="ga1eb29d664fde12ed80f9c89c37345a5d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdateHnicCryptoStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a>&#160;</td>
          <td class="paramname"><em>CryptoStatusOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CryptoMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to set crypto status bit of HNIC. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">CryptoStatusOp</td><td>Operation to set or clear crypto status bit </td></tr>
    <tr><td class="paramname">CryptoMask</td><td>Mask to set or clear crypto status bit</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acadac31f02339f8ef8d0e6058c5c40dbbb">XSECURE_API_UPDATE_HNIC_CRYPTO_STATUS</a>.</p>

</div>
</div>
<a class="anchor" id="gaf7393da6128bf378cf635d7f851e18ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdatePcideCryptoStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a>&#160;</td>
          <td class="paramname"><em>CryptoStatusOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CryptoMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to set crypto status bit of PCIDE. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">CryptoStatusOp</td><td>Operation to set or clear crypto status bit </td></tr>
    <tr><td class="paramname">CryptoMask</td><td>Mask to set or clear crypto status bit</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca779769fce2f901b43cc58900383c3e93">XSECURE_API_UPDATE_PCIDE_CRYPTO_STATUS</a>.</p>

</div>
</div>
<a class="anchor" id="gae60f390422826e0edcd5c4aada5a8953"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdatePkiCryptoStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gaf98e2daceaa40abe4137731873618bd0">XSecure_CryptoStatusOp</a>&#160;</td>
          <td class="paramname"><em>CryptoStatusOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CryptoMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to set crypto status bit of PKI. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">CryptoStatusOp</td><td>Operation to set or clear crypto status bit </td></tr>
    <tr><td class="paramname">CryptoMask</td><td>Mask to set or clear crypto status bit</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acaab46c22eae0bfecb0e69dd1f1e6bb939">XSECURE_API_UPDATE_PKI_CRYPTO_STATUS</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
